﻿/*
Copyright 2009 Matías Fidemraizer (www.matiasfidemraizer.com).

    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
    You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing, software
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
    limitations under the License.
*/

using System;

#region "Custom namespace declarations"
using Comkarl.Architecture.Patterns.MVC.Entities;
#endregion

namespace Comkarl
{
    /// <summary>
    /// An exception thrown when a null identifier has been found.
    /// </summary>
    /// <typeparam name="TIdentifierName">
    /// The type for the identifier's name.
    /// </typeparam>
    public sealed class IdentifierNullException<TIdentifierName> : IdentifierException<TIdentifierName> where TIdentifierName : IEquatable<TIdentifierName>
    {
        #region Constructor
        /// <summary>
        /// Default constructor.
        /// </summary>
        /// <param name="innerException">
        /// An optional exception which can be set if some underlying exception has been thrown.
        /// </param>
        public IdentifierNullException(Exception innerException)
            : base("An identifier cannot be null.", null, innerException)
        {
        }
        #endregion

        #region Hidden members
        /// <summary>
        /// Hides the CurrentIdentifier inherited property because the exception won't 
        /// be able to provide an identifier since it's going to be null.
        /// </summary>
        new private string CurrentIdentifier;
        #endregion
    }
}
